home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / ear / mui23dev.lha / MUI / Developer / Autodocs / MUI_Window.doc < prev    next >
Text File  |  1994-12-23  |  25KB  |  947 lines
  1. TABLE OF CONTENTS
  2.  
  3. Window.mui/Window.mui
  4. Window.mui/MUIM_Window_GetMenuCheck
  5. Window.mui/MUIM_Window_GetMenuState
  6. Window.mui/MUIM_Window_ScreenToBack
  7. Window.mui/MUIM_Window_ScreenToFront
  8. Window.mui/MUIM_Window_SetCycleChain
  9. Window.mui/MUIM_Window_SetMenuCheck
  10. Window.mui/MUIM_Window_SetMenuState
  11. Window.mui/MUIM_Window_ToBack
  12. Window.mui/MUIM_Window_ToFront
  13. Window.mui/MUIA_Window_Activate
  14. Window.mui/MUIA_Window_ActiveObject
  15. Window.mui/MUIA_Window_AltHeight
  16. Window.mui/MUIA_Window_AltLeftEdge
  17. Window.mui/MUIA_Window_AltTopEdge
  18. Window.mui/MUIA_Window_AltWidth
  19. Window.mui/MUIA_Window_AppWindow
  20. Window.mui/MUIA_Window_Backdrop
  21. Window.mui/MUIA_Window_Borderless
  22. Window.mui/MUIA_Window_CloseGadget
  23. Window.mui/MUIA_Window_CloseRequest
  24. Window.mui/MUIA_Window_DefaultObject
  25. Window.mui/MUIA_Window_DepthGadget
  26. Window.mui/MUIA_Window_DragBar
  27. Window.mui/MUIA_Window_FancyDrawing
  28. Window.mui/MUIA_Window_Height
  29. Window.mui/MUIA_Window_ID
  30. Window.mui/MUIA_Window_InputEvent
  31. Window.mui/MUIA_Window_LeftEdge
  32. Window.mui/MUIA_Window_Menu
  33. Window.mui/MUIA_Window_MenuAction
  34. Window.mui/MUIA_Window_Menustrip
  35. Window.mui/MUIA_Window_MouseObject
  36. Window.mui/MUIA_Window_NeedsMouseObject
  37. Window.mui/MUIA_Window_NoMenus
  38. Window.mui/MUIA_Window_Open
  39. Window.mui/MUIA_Window_PublicScreen
  40. Window.mui/MUIA_Window_RefWindow
  41. Window.mui/MUIA_Window_RootObject
  42. Window.mui/MUIA_Window_Screen
  43. Window.mui/MUIA_Window_ScreenTitle
  44. Window.mui/MUIA_Window_SizeGadget
  45. Window.mui/MUIA_Window_SizeRight
  46. Window.mui/MUIA_Window_Sleep
  47. Window.mui/MUIA_Window_Title
  48. Window.mui/MUIA_Window_TopEdge
  49. Window.mui/MUIA_Window_Width
  50. Window.mui/MUIA_Window_Window
  51. Window.mui/Window.mui
  52.  
  53.     Objects of window class are used to generate windows and
  54.     supply a place where MUI gadgets feel well. It handles
  55.     the complicated task of window resizing fully automatic,
  56.     you don't need to worry about that.
  57.  
  58.     Windows are children of an application, you cannot use
  59.     a window object without having a parent application
  60.     object. On the other side, the gadgets in a window
  61.     are children of the window, you cannot use MUI gadgets
  62.     without having a parent MUI window.
  63.  
  64.     Creating a window object does not mean to open it
  65.     instantly. This is done later by setting the window's
  66.     MUIA_Window_Open attribute. If your application has
  67.     several windows, the usual way is to create them all
  68.     at once at startup time and open/close it later
  69.     just by setting MUIA_Window_Open.
  70.  
  71.     There is no difference in talking to gadgets whether
  72.     their parent window is open or not. If you e.g. set
  73.     the contents of a string gadget in an open window,
  74.     the gadget will refresh immediately. If the window is
  75.     closed, the gadget just remembers its new setting
  76.     and displays it later.
  77. Window.mui/MUIM_Window_GetMenuCheck
  78.  
  79.     NAME
  80.     MUIM_Window_GetMenuCheck (V4 ) (OBSOLETE)
  81.  
  82.     SYNOPSIS
  83.     DoMethod(obj,MUIM_Window_GetMenuCheck,ULONG MenuID);
  84.  
  85.     FUNCTION
  86.     Ask whether a checkmark menu item has its
  87.     checkmark set or cleared.
  88.  
  89.     INPUTS
  90.     MenuID - the value you wrote into the
  91.                  UserData field of struct NewMenu.
  92.  
  93.     SEE ALSO
  94.     MUIM_Window_SetMenuCheck, MUIA_Window_Menu
  95. Window.mui/MUIM_Window_GetMenuState
  96.  
  97.     NAME
  98.     MUIM_Window_GetMenuState (V4 ) (OBSOLETE)
  99.  
  100.     SYNOPSIS
  101.     DoMethod(obj,MUIM_Window_GetMenuState,ULONG MenuID);
  102.  
  103.     FUNCTION
  104.     Ask whether a menu item is enabled or disabled.
  105.  
  106.     INPUTS
  107.     MenuID - the value you wrote into the
  108.                  UserData field of struct NewMenu.
  109.  
  110.     SEE ALSO
  111.     MUIM_Window_SetMenuState, MUIA_Window_Menu
  112. Window.mui/MUIM_Window_ScreenToBack
  113.  
  114.     NAME
  115.     MUIM_Window_ScreenToBack (V4 )
  116.  
  117.     SYNOPSIS
  118.     DoMethod(obj,MUIM_Window_ScreenToBack,);
  119.  
  120.     FUNCTION
  121.     Put the window's screen to back. This command is
  122.     only valid when the window is opened.
  123.  
  124.     SEE ALSO
  125.     MUIM_Window_ScreenToFront, MUIM_Window_ToFront,
  126.     MUIM_Window_ToBack
  127. Window.mui/MUIM_Window_ScreenToFront
  128.  
  129.     NAME
  130.     MUIM_Window_ScreenToFront (V4 )
  131.  
  132.     SYNOPSIS
  133.     DoMethod(obj,MUIM_Window_ScreenToFront,);
  134.  
  135.     FUNCTION
  136.     Put the window's screen to font. This command is
  137.     only valid when the window is opened.
  138.  
  139.     SEE ALSO
  140.     MUIM_Window_ScreenToBack, MUIM_Window_ToFront,
  141.     MUIM_Window_ToBack
  142. Window.mui/MUIM_Window_SetCycleChain
  143.  
  144.     NAME
  145.     MUIM_Window_SetCycleChain (V4 )
  146.  
  147.     SYNOPSIS
  148.     DoMethod(obj,MUIM_Window_SetCycleChain,Object *obj[1]);
  149.  
  150.     FUNCTION
  151.     Set the cycle chain for a window. To make MUI's keyboard
  152.     control work, you need to setup a chain of objects that
  153.     should be activatable with the tab key. This can be
  154.     any objects you wish, MUI supports complete keyboard
  155.     handling even for sliders or listviews.
  156.  
  157.     If you forget to set a cycle chain because you
  158.     are a mouse-man, you certainly will annoy some
  159.     users of your application!
  160.  
  161.     INPUTS
  162.     One or more objects, terminated with a NULL.
  163.  
  164.     EXAMPLE
  165.     DoMethod(window,MUIM_Window_SetCycleChain,
  166.        str1,str2,slide1,list,radio,cycle1,cycle2,NULL);
  167.  
  168.     SEE ALSO
  169.     MUIA_Window_ActiveObject
  170. Window.mui/MUIM_Window_SetMenuCheck
  171.  
  172.     NAME
  173.     MUIM_Window_SetMenuCheck (V4 ) (OBSOLETE)
  174.  
  175.     SYNOPSIS
  176.     DoMethod(obj,MUIM_Window_SetMenuCheck,ULONG MenuID, LONG stat);
  177.  
  178.     FUNCTION
  179.     Set or clear the checkmark of a menu item.
  180.  
  181.     INPUTS
  182.     MenuID - the value you wrote into the
  183.                  UserData field of struct NewMenu.
  184.  
  185.     set    - TRUE to set checkmark, FALSE to clear
  186.  
  187.     SEE ALSO
  188.     MUIM_Window_GetMenuCheck, MUIA_Window_Menu,
  189. Window.mui/MUIM_Window_SetMenuState
  190.  
  191.     NAME
  192.     MUIM_Window_SetMenuState (V4 ) (OBSOLETE)
  193.  
  194.     SYNOPSIS
  195.     DoMethod(obj,MUIM_Window_SetMenuState,ULONG MenuID, LONG stat);
  196.  
  197.     FUNCTION
  198.     Enable or disable a menu item.
  199.  
  200.     INPUTS
  201.     MenuID - the value you wrote into the
  202.                  UserData field of struct NewMenu.
  203.  
  204.     set    - TRUE to enable item, FALSE to disable.
  205.  
  206.     SEE ALSO
  207.     MUIM_Window_GetMenuState, MUIA_Window_Menu,
  208. Window.mui/MUIM_Window_ToBack
  209.  
  210.     NAME
  211.     MUIM_Window_ToBack (V4 )
  212.  
  213.     SYNOPSIS
  214.     DoMethod(obj,MUIM_Window_ToBack,);
  215.  
  216.     FUNCTION
  217.     Put the window to back. When the window is not currently open,
  218.     this command does simply nothing.
  219.  
  220.     SEE ALSO
  221.     MUIM_Window_ToFront, MUIM_Window_ScreenToFront,
  222.     MUIM_Window_ScreenToBack
  223. Window.mui/MUIM_Window_ToFront
  224.  
  225.     NAME
  226.     MUIM_Window_ToFront (V4 )
  227.  
  228.     SYNOPSIS
  229.     DoMethod(obj,MUIM_Window_ToFront,);
  230.  
  231.     FUNCTION
  232.     Put the window to front. When the window is not currently open,
  233.     this command does simply nothing.
  234.  
  235.     SEE ALSO
  236.     MUIM_Window_ToBack, MUIM_Window_ScreenToFront,
  237.     MUIM_Window_ScreenToBack
  238. Window.mui/MUIA_Window_Activate
  239.  
  240.     NAME
  241.     MUIA_Window_Activate -- (V4 ) [ISG], BOOL
  242.  
  243.     FUNCTION
  244.     Setting this to TRUE will activate the window.
  245.     Setting this to FALSE has no effect.
  246.     The attribute will change whenever the user
  247.     activates/deactivates the window.
  248.  
  249.     Specifying FALSE at object creation time will make
  250.     the window open in an inactive state.
  251. Window.mui/MUIA_Window_ActiveObject
  252.  
  253.     NAME
  254.     MUIA_Window_ActiveObject -- (V4 ) [.SG], Object *
  255.  
  256.     SPECIAL INPUTS
  257.     MUIV_Window_ActiveObject_None
  258.     MUIV_Window_ActiveObject_Next
  259.     MUIV_Window_ActiveObject_Prev
  260.  
  261.     FUNCTION
  262.     Set the active object in a window as if the user
  263.     would have activated it with the tab key. The
  264.     object has to be in the cycle chain for this
  265.     command to work.
  266.  
  267.     EXAMPLE
  268.     set(window,MUIA_Window_ActiveObject,okaybutton);
  269.  
  270.     SEE ALSO
  271.     MUIM_Window_SetCycleChain
  272. Window.mui/MUIA_Window_AltHeight
  273.  
  274.     NAME
  275.     MUIA_Window_AltHeight -- (V4 ) [I.G], LONG
  276.  
  277.     SPECIAL INPUTS
  278.     MUIV_Window_AltHeight_MinMax(p)
  279.     MUIV_Window_AltHeight_Visible(p)
  280.     MUIV_Window_AltHeight_Screen(p)
  281.     MUIV_Window_AltHeight_Scaled
  282.  
  283.     FUNCTION
  284.     Specify the alternate (zoomed) height of a window.
  285.     If not present, the alternate height will be the
  286.     minimum height.
  287.  
  288.     SEE ALSO
  289.     MUIA_Window_Height, MUIA_Window_AltWidth
  290. Window.mui/MUIA_Window_AltLeftEdge
  291.  
  292.     NAME
  293.     MUIA_Window_AltLeftEdge -- (V4 ) [I.G], LONG
  294.  
  295.     SPECIAL INPUTS
  296.     MUIV_Window_AltLeftEdge_Centered
  297.     MUIV_Window_AltLeftEdge_Moused
  298.     MUIV_Window_AltLeftEdge_NoChange
  299.  
  300.     FUNCTION
  301.     Specify the alternate (zoomed) left position of
  302.     a window. This defaults to the standard left
  303.     position.
  304.  
  305.     SEE ALSO
  306.     MUIA_Window_LeftEdge, MUIA_Window_AltTopEdge
  307. Window.mui/MUIA_Window_AltTopEdge
  308.  
  309.     NAME
  310.     MUIA_Window_AltTopEdge -- (V4 ) [I.G], LONG
  311.  
  312.     SPECIAL INPUTS
  313.     MUIV_Window_AltTopEdge_Centered
  314.     MUIV_Window_AltTopEdge_Moused
  315.     MUIV_Window_AltTopEdge_Delta(p)
  316.     MUIV_Window_AltTopEdge_NoChange
  317.  
  318.     FUNCTION
  319.     Specify the alternate (zoomed) top position of
  320.     a window. This defaults to the standard top
  321.     position.
  322.  
  323.     SEE ALSO
  324.     MUIA_Window_TopEdge, MUIA_Window_AltLeftEdge
  325. Window.mui/MUIA_Window_AltWidth
  326.  
  327.     NAME
  328.     MUIA_Window_AltWidth -- (V4 ) [I.G], LONG
  329.  
  330.     SPECIAL INPUTS
  331.     MUIV_Window_AltWidth_MinMax(p)
  332.     MUIV_Window_AltWidth_Visible(p)
  333.     MUIV_Window_AltWidth_Screen(p)
  334.     MUIV_Window_AltWidth_Scaled
  335.  
  336.     FUNCTION
  337.     Specify the alternate (zoomed) width of a window.
  338.     If not present, the alternate width will be the
  339.     minimum width.
  340.  
  341.     SEE ALSO
  342.     MUIA_Window_Width, MUIA_Window_AltHeight
  343. Window.mui/MUIA_Window_AppWindow
  344.  
  345.     NAME
  346.     MUIA_Window_AppWindow -- (V5 ) [I..], BOOL
  347.  
  348.     FUNCTION
  349.     Setting this attribute to TRUE will make this window an
  350.     AppWindow, the user will be able to drop icons on it.
  351.     You can hear about these events by listening to the
  352.     MUIA_AppMessage attribute.
  353.  
  354.     SEE ALSO
  355.     MUIA_AppMessage, MUIA_Application_DropObject
  356. Window.mui/MUIA_Window_Backdrop
  357.  
  358.     NAME
  359.     MUIA_Window_Backdrop -- (V4 ) [I..], BOOL
  360.  
  361.     FUNCTION
  362.     Make the window a backdrop window.
  363. Window.mui/MUIA_Window_Borderless
  364.  
  365.     NAME
  366.     MUIA_Window_Borderless -- (V4 ) [I..], BOOL
  367.  
  368.     FUNCTION
  369.     Make the window borderless.
  370. Window.mui/MUIA_Window_CloseGadget
  371.  
  372.     NAME
  373.     MUIA_Window_CloseGadget -- (V4 ) [I..], BOOL
  374.  
  375.     FUNCTION
  376.     Set this to FALSE and your window will not
  377.     have a close gadget.
  378. Window.mui/MUIA_Window_CloseRequest
  379.  
  380.     NAME
  381.     MUIA_Window_CloseRequest -- (V4 ) [..G], BOOL
  382.  
  383.     FUNCTION
  384.     When the user hits a windows close gadget, the
  385.     window isn't closed immediately. Instead MUI only
  386.     sets this attribute to TRUE to allow your application
  387.     to react.
  388.  
  389.     Usually, you will setup a notification that automatically
  390.     closes the window when a close request appears, but you
  391.     could e.g. pop up a confirmation requester or do some
  392.     other things first.
  393.  
  394.     EXAMPLE
  395.     /* automagically close a window     */
  396.     /* when the close gadget is pressed */
  397.  
  398.     DoMethod(window,MUIM_Notify,
  399.        MUIA_Window_CloseRequest, TRUE,
  400.        window,3,MUIM_Set,MUIA_Window_Open,0);
  401.  
  402.     SEE ALSO
  403.     MUIA_Window_Open
  404. Window.mui/MUIA_Window_DefaultObject
  405.  
  406.     NAME
  407.     MUIA_Window_DefaultObject -- (V4 ) [ISG], Object *
  408.  
  409.     FUNCTION
  410.     The default object in a window receives keyboard input
  411.     as long as no other object is active. Good candidates
  412.     for default objects are e.g. lonely listviews. Making
  413.     such a listview the default object will allow the user
  414.     to control it immediately without the need of several
  415.     tab strokes for activation.
  416.  
  417.     SEE ALSO
  418.     MUIA_Window_ActiveObject
  419. Window.mui/MUIA_Window_DepthGadget
  420.  
  421.     NAME
  422.     MUIA_Window_DepthGadget -- (V4 ) [I..], BOOL
  423.  
  424.     FUNCTION
  425.     Enable or disable the depth gadget. Defaults to TRUE.
  426.     There is no good reason to use this tag.
  427. Window.mui/MUIA_Window_DragBar
  428.  
  429.     NAME
  430.     MUIA_Window_DragBar -- (V4 ) [I..], BOOL
  431.  
  432.     FUNCTION
  433.     Tell MUI to give your window a dragbar.
  434.  
  435.     Defaults to TRUE.
  436.  
  437.     There is no good reason to disable the dragbar!
  438. Window.mui/MUIA_Window_FancyDrawing
  439.  
  440.     NAME
  441.     MUIA_Window_FancyDrawing -- (V8 ) [ISG], BOOL
  442.  
  443.     FUNCTION
  444.     Usually, the only possible place to do some rendering is
  445.     during a MUIM_Draw method. However, if you have a class
  446.     that really requires very high graphical output speed
  447.     (e.g. a module players scope or a game class), you can
  448.     set MUIA_Window_FancyDrawing to TRUE.
  449.  
  450.     This allows your class to render anywhere between
  451.     MUIM_Show and MUIM_Hide, e.g. directly after an
  452.     attribute change with OM_SET or from a seperate
  453.     task.
  454.  
  455.     Note that your rastport etc. is only valid between
  456.     MUIM_Show and MUIM_Hide. Keep that in mind!
  457.  
  458.     When drawing from a seperate task, you have to clone
  459.     the RastPort and use the copy for your rendering!
  460.  
  461.     NOTES
  462.     Please use this attribute sparingly. It might prevent
  463.     MUI from doing nice things with your window, e.g.
  464.     building an automatic virtual group when the screen
  465.     is too small.
  466.  
  467.     MUIA_Window_FancyDrawing is really only necessary for
  468.     very few types of applications. You should use the
  469.     traditional way (MUIM_Draw and MUI_Redraw()) whenever
  470.     and wherever possible!
  471. Window.mui/MUIA_Window_Height
  472.  
  473.     NAME
  474.     MUIA_Window_Height -- (V4 ) [I.G], LONG
  475.  
  476.     SPECIAL INPUTS
  477.     MUIV_Window_Height_MinMax(p)
  478.     MUIV_Window_Height_Visible(p)
  479.     MUIV_Window_Height_Screen(p)
  480.     MUIV_Window_Height_Scaled
  481.     MUIV_Window_Height_Default
  482.  
  483.     FUNCTION
  484.     Specify the height of a window. Usually, you won't give
  485.     a pixel value here but instead use one of the following
  486.     magic macros:
  487.  
  488.     MUIV_Window_Height_Default:
  489.        calculated from objects default sizes.
  490.  
  491.     MUIV_Window_Height_MinMax(0..100):
  492.        somewhere between the minimum height (0) and the
  493.        maximum height (100) of your window.
  494.  
  495.     MUIV_Window_Height_Visible(1..100):
  496.        percentage of the screens visible height.
  497.  
  498.     MUIV_Window_Height_Screen(1..100):
  499.        percentage of the screens total height.
  500.  
  501.     MUIV_Window_Height_Scaled:
  502.        height will be adjusted so that
  503.        width : height == minimum width : minimum height.
  504.        Note that a windows width and height may not
  505.        both be scaled.
  506.  
  507.     Default for this tag is MUIV_Window_Height_Default.
  508.  
  509.     As long as your window has a window id (MUIA_Window_ID),
  510.     choosing a size is not that important. MUI will always
  511.     remember a windows last position and size and these
  512.     values will simply override your settings. Positioning
  513.     and sizing should be completely under user control,
  514.     a programmer doesn't need to worry about it.
  515.  
  516.     SEE ALSO
  517.     MUIA_Window_Width, MUIA_Window_ID
  518. Window.mui/MUIA_Window_ID
  519.  
  520.     NAME
  521.     MUIA_Window_ID -- (V4 ) [ISG], ULONG
  522.  
  523.     FUNCTIONS
  524.     For most of your windows, you should define a longword
  525.     as id value. Only a window with an id is able to
  526.     remember its size and position.
  527.  
  528.     Additionally, when you use an ascii id (e.g. 'MAIN'),
  529.     your window can be controlled from ARexx.
  530.  
  531.     Of course all windows of your application must have
  532.     unique ids.
  533.  
  534.     SEE ALSO
  535.     MUIA_Window_LeftEdge
  536. Window.mui/MUIA_Window_InputEvent
  537.  
  538.     NAME
  539.     MUIA_Window_InputEvent -- (V4 ) [..G], struct InputEvent *
  540.  
  541.     FUNCTION
  542.     This attribute gets set whenever your window receives
  543.     a rawkey input event. You can react on this by creating
  544.     a notification event containing a standard
  545.     commodities.library input description string.
  546.  
  547.     EXAMPLE
  548.     DoMethod(window, MUIM_Notify,
  549.        MUIA_Window_InputEvent, "control p",
  550.        txobj, 3,
  551.        MUIM_Set, MUIA_Text_Contents, "user pressed ctrl p");
  552. Window.mui/MUIA_Window_LeftEdge
  553.  
  554.     NAME
  555.     MUIA_Window_LeftEdge -- (V4 ) [I.G], LONG
  556.  
  557.     SPECIAL INPUTS
  558.     MUIV_Window_LeftEdge_Centered
  559.     MUIV_Window_LeftEdge_Moused
  560.  
  561.     FUNCTION
  562.     Specify the left edge of a window. Usually, you shouldn't
  563.     define a pixel value here but instead use one of the
  564.     following macros:
  565.  
  566.     MUIV_Window_LeftEdge_Centered:
  567.        window appears centered on the visible area of screen.
  568.  
  569.     MUIV_Window_LeftEdge_Moused
  570.        window appears centered under the mouse pointer.
  571.  
  572.     Default for this tag is MUIV_Window_LeftEdge_Centered.
  573.  
  574.     As long as your window has a window id (MUIA_Window_ID),
  575.     choosing a position is not that important. MUI will always
  576.     remember a windows last position and size and these
  577.     values will simply override your settings. Positioning
  578.     and sizing should be completely under user control,
  579.     a programmer doesn't need to worry about it.
  580.  
  581.     SEE ALSO
  582.     MUIA_Window_TopEdge, MUIA_Window_ID
  583. Window.mui/MUIA_Window_Menu
  584.  
  585.     NAME
  586.     MUIA_Window_Menu -- (V4 ) [I..], struct NewMenu * (OBSOLETE)
  587.  
  588.     SPECIAL INPUTS
  589.     MUIV_Window_Menu_NoMenu
  590.  
  591.     FUNCTION
  592.     Obsolete, use MUIA_Window_Menustrip instead.
  593.  
  594.     SEE ALSO
  595.     MUIA_Window_Menustrip
  596. Window.mui/MUIA_Window_MenuAction
  597.  
  598.     NAME
  599.     MUIA_Window_MenuAction -- (V8 ) [ISG], ULONG
  600.  
  601.     FUNCTION
  602.     Whenever a menu item is selected, this attribute will be
  603.     set to the corresponding UserData field of the gadtools
  604.     NewMenu structure. This allows reacting on menu items
  605.     via broadcasting.
  606.  
  607.     SEE ALSO
  608.     MUIA_Window_Menu
  609. Window.mui/MUIA_Window_Menustrip
  610.  
  611.     NAME
  612.     MUIA_Window_Menustrip -- (V8 ) [I..], Object *
  613.  
  614.     FUNCTION
  615.     Specify a menu strip object for this window. The object
  616.     is treated as a child of the window and will be disposed
  617.     when the window is disposed.
  618.  
  619.     Menustrip objects defined for a window will override an
  620.     applications Menustrip object.
  621.  
  622.     MUIA_Window_Menustrip replaces the old and obsolete
  623.     MUIA_Window_Menu tag.
  624.  
  625.     Usually, you will create the menu object with MUI's builtin
  626.     object library from a gadtools NewMenu structure, but its
  627.     also OK to define the menu tree "by hand" using the
  628.     Family class.
  629.  
  630.     If you have a global menu for all your applications windows
  631.     but you want some windows to have no menu, use the
  632.     MUIA_Window_NoMenus tag.
  633.  
  634.     SEE ALSO
  635.     MUIA_Window_NoMenus
  636. Window.mui/MUIA_Window_MouseObject
  637.  
  638.     NAME
  639.     MUIA_Window_MouseObject -- (V10) [..G], Object *
  640.  
  641.     FUNCTION
  642.     When MUIA_Window_NeedsMouseObject is enabled for this window,
  643.     you can setup notificationns on MUIA_Window_MouseObject to
  644.     find out on which object the mouse pointer is located.
  645.  
  646.     SEE ALSO
  647.     MUIA_Window_NeedsMouseObject
  648. Window.mui/MUIA_Window_NeedsMouseObject
  649.  
  650.     NAME
  651.     MUIA_Window_NeedsMouseObject -- (V10) [I..], BOOL
  652.  
  653.     FUNCTION
  654.     If you want to react on changes of the MUIA_Window_MouseObject
  655.     attribute, you have to set this to TRUE when creating your
  656.     window.
  657.  
  658.     SEE ALSO
  659.     MUIA_Window_MouseObject
  660. Window.mui/MUIA_Window_NoMenus
  661.  
  662.     NAME
  663.     MUIA_Window_NoMenus -- (V4 ) [IS.], BOOL
  664.  
  665.     FUNCTION
  666.     Temporarily disable the menu strip of a window.
  667.  
  668.     SEE ALSO
  669.     MUIA_Window_Menu
  670. Window.mui/MUIA_Window_Open
  671.  
  672.     NAME
  673.     MUIA_Window_Open -- (V4 ) [.SG], BOOL
  674.  
  675.     FUNCTION
  676.     This little attribute can be used to open and close
  677.     a window. When opening a window, MUI does lots of
  678.     stuff to calculate sizes and positions of all
  679.     gadgets. Minimum and maximum window sizes will be
  680.     adjusted automatically.
  681.  
  682.     When the minimum size of a window is too big to fit
  683.     on the screen, MUI tries to reduce font sizes and
  684.     does a new calculation. You should always design
  685.     your windows to fit on a 640*200 screen with
  686.     all fonts set to topaz/8.
  687.  
  688.     When a window is closed (and you specified a
  689.     MUIA_Window_ID), MUI remembers its position
  690.     and size and uses these values during the next
  691.     opening.
  692.  
  693.     After setting MUIA_Window_Open to TRUE, you should
  694.     test if MUI was able to open the window by getting
  695.     the attribute again. If you don't and if this was
  696.     the only window of your application, the user won't
  697.     be able to do any input and your application will
  698.     seem to hang.
  699.  
  700.     EXAMPLE
  701.     set(window,MUIA_Window_Open,TRUE);
  702.     get(window,MUIA_Window_Open,&open);
  703.     if (!open)
  704.     {
  705.        MUI_Request(app,0,0,0,"Ok","Failed to open window.");
  706.        exit(20);
  707.     }
  708.  
  709.     SEE ALSO
  710.     MUIA_Window_RootObject
  711. Window.mui/MUIA_Window_PublicScreen
  712.  
  713.     NAME
  714.     MUIA_Window_PublicScreen -- (V6 ) [ISG], STRPTR
  715.  
  716.     FUNCTION
  717.     Force the window to appear on the public screen who's name
  718.     is specified by this attribute. This tag overrides the
  719.     user preferences setting and is overridden by
  720.     MUIA_Window_Screen.
  721.  
  722.     Please use this tag sparely, overriding user prefs is
  723.     not a good idea!
  724.  
  725.     SEE ALSO
  726.     MUIA_Window_Screen
  727. Window.mui/MUIA_Window_RefWindow
  728.  
  729.     NAME
  730.     MUIA_Window_RefWindow -- (V4 ) [IS.], Object *
  731.  
  732.     FUNCTION
  733.     Setting MUIA_Window_RefWindow to another MUI window
  734.     object will make the left and top position relative
  735.     to this reference window. Using the
  736.     MUIA_Window_Left(Top)Edge_Centered tag, you can easily
  737.     open one window within another.
  738.  
  739.     Note that if your window has an id, the window will
  740.     remember its last position and reopen there. Thus,
  741.     this tag is only useful if you omit MUIA_Window_ID,
  742.     maybe for some small requester windows.
  743.  
  744.     SEE ALSO
  745.     MUIA_Window_ID, MUIA_Window_LeftEdge
  746. Window.mui/MUIA_Window_RootObject
  747.  
  748.     NAME
  749.     MUIA_Window_RootObject -- (V4 ) [I..], Object *
  750.  
  751.     FUNCTION
  752.     This is a pointer to a MUI object and defines the
  753.     contents of your window. Usually, this root object
  754.     will be of class MUIC_Group since you surely want to
  755.     have more than one gadget.
  756.  
  757.     The root object is treated as child of a window
  758.     and will be disposed when the window is disposed.
  759.     Note that windows can only have one child.
  760.  
  761.     Although you may create a window without root object,
  762.     you have to set one before the window is openend!
  763.  
  764.     EXAMPLE
  765.     win = WindowObject, MUIA_Window_RootObject,
  766.        VGroup,
  767.           Child, ...,
  768.           Child, ...,
  769.           End,
  770.        End;
  771.  
  772.     SEE ALSO
  773.     MUIA_Window_Open
  774. Window.mui/MUIA_Window_Screen
  775.  
  776.     NAME
  777.     MUIA_Window_Screen -- (V4 ) [ISG], struct Screen *
  778.  
  779.     FUNCTION
  780.     You can get a pointer to the parent screen of a window by 
  781.     getting this attribute. The result will be NULL when the
  782.     window is currently closed.
  783.  
  784.     Specifying MUIA_Window_Screen at object creation time or
  785.     with a SetAttrs() call allows you to explicitly tell MUI
  786.     on which screen the window should be opened. You normally
  787.     won't need this feature and leave the decision about
  788.     screens to the users preferences setting.
  789.  
  790.     SEE ALSO
  791.     MUIA_Window_PublicScreen, MUIA_Window_Window
  792. Window.mui/MUIA_Window_ScreenTitle
  793.  
  794.     NAME
  795.     MUIA_Window_ScreenTitle -- (V5 ) [ISG], STRPTR
  796.  
  797.     FUNCTION
  798.     This text will appear in the screens title bar
  799.     when the window is active.
  800.  
  801.     SEE ALSO
  802.     MUIA_Window_Title
  803. Window.mui/MUIA_Window_SizeGadget
  804.  
  805.     NAME
  806.     MUIA_Window_SizeGadget -- (V4 ) [I..], BOOL
  807.  
  808.     FUNCTION
  809.     Tell MUI if you want a sizing gadget for this window.
  810.     Usually you won't need this attribute since MUI
  811.     will automatically disable the sizing gadget when
  812.     your window is not sizeable because of your gadget
  813.     layout.
  814. Window.mui/MUIA_Window_SizeRight
  815.  
  816.     NAME
  817.     MUIA_Window_SizeRight -- (V4 ) [I..], BOOL
  818.  
  819.     FUNCTION
  820.     When set to TRUE, the size gadget will reside
  821.     in the right window border.
  822. Window.mui/MUIA_Window_Sleep
  823.  
  824.     NAME
  825.     MUIA_Window_Sleep -- (V4 ) [.SG], BOOL
  826.  
  827.     FUNCTION
  828.     This attribute can be used to put a window to sleep.
  829.     The window gets disabled and a busy pointer appears.
  830.  
  831.     The attribute contains a nesting count, if you tell
  832.     your window to sleep twice, you will have to tell
  833.     it to wake up twice too.
  834.  
  835.     A sleeping window cannot be resized.
  836.  
  837.     SEE ALSO
  838.     MUIA_Application_Sleep
  839. Window.mui/MUIA_Window_Title
  840.  
  841.     NAME
  842.     MUIA_Window_Title -- (V4 ) [ISG], STRPTR
  843.  
  844.     FUNCTION
  845.     Specify the title of a window.
  846.  
  847.     SEE ALSO
  848.     MUIA_Window_ScreenTitle
  849. Window.mui/MUIA_Window_TopEdge
  850.  
  851.     NAME
  852.     MUIA_Window_TopEdge -- (V4 ) [I.G], LONG
  853.  
  854.     SPECIAL INPUTS
  855.     MUIV_Window_TopEdge_Centered
  856.     MUIV_Window_TopEdge_Moused
  857.     MUIV_Window_TopEdge_Delta(p)
  858.  
  859.     FUNCTION
  860.     Specify the top edge of a window. Usually, you shouldn't
  861.     define a pixel value here but instead use one of the
  862.     following macros:
  863.  
  864.     MUIV_Window_TopEdge_Centered:
  865.        window appears centered on the visible area of screen.
  866.  
  867.     MUIV_Window_TopEdge_Moused
  868.        window appears centered under the mouse pointer.
  869.  
  870.     MUIV_Window_TopEdge_Delta(p)
  871.        window appears p pixels below the screens title bar.
  872.  
  873.     Default for this tag is MUIV_Window_TopEdge_Centered.
  874.  
  875.     As long as your window has a window id (MUIA_Window_ID),
  876.     choosing a position is not that important. MUI will always
  877.     remember a windows last position and size and these
  878.     values will simply override your settings. Positioning
  879.     and sizing should be completely under user control,
  880.     a programmer doesn't need to worry about it.
  881.  
  882.     SEE ALSO
  883.     MUIA_Window_LeftEdge, MUIA_Window_ID
  884. Window.mui/MUIA_Window_Width
  885.  
  886.     NAME
  887.     MUIA_Window_Width -- (V4 ) [I.G], LONG
  888.  
  889.     SPECIAL INPUTS
  890.     MUIV_Window_Width_MinMax(p)
  891.     MUIV_Window_Width_Visible(p)
  892.     MUIV_Window_Width_Screen(p)
  893.     MUIV_Window_Width_Scaled
  894.     MUIV_Window_Width_Default
  895.  
  896.     FUNCTION
  897.     Specify the width of a window. Usually, you won't give
  898.     a pixel value here but instead use one of the following
  899.     magic macros:
  900.  
  901.     MUIV_Window_Width_Default:
  902.        calculated from objects default sizes.
  903.  
  904.     MUIV_Window_Width_MinMax(0..100):
  905.        somewhere between the minimum width (0) and the
  906.        maximum width (100) of your window.
  907.  
  908.     MUIV_Window_Width_Visible(1..100):
  909.        percentage of the screens visible width.
  910.  
  911.     MUIV_Window_Width_Screen(1..100):
  912.        percentage of the screens total width.
  913.  
  914.     MUIV_Window_Width_Scaled:
  915.        width will be adjusted so that
  916.        width : height == minimum width : minimum height.
  917.        Note that a windows width and height may not
  918.        both be scaled.
  919.  
  920.     Default for this tag is MUIV_Window_Width_Default.
  921.  
  922.     As long as your window has a window id (MUIA_Window_ID),
  923.     choosing a size is not that important. MUI will always
  924.     remember a windows last position and size and these
  925.     values will simply override your settings. Positioning
  926.     and sizing should be completely under user control,
  927.     a programmer doesn't need to worry about it.
  928.  
  929.     SEE ALSO
  930.     MUIA_Window_Height, MUIA_Window_ID
  931. Window.mui/MUIA_Window_Window
  932.  
  933.     NAME
  934.     MUIA_Window_Window -- (V4 ) [..G], struct Window *
  935.  
  936.     FUNCTION
  937.     When your window is open, you can obtain a pointer
  938.     to the intuition Window structure with this tag
  939.     and use it e.g. in an asl.library requester call.
  940.  
  941.     Since the user can close your window any time
  942.     (e.g. iconification), you must be prepared to
  943.     receive a NULL pointer as result.
  944.  
  945.     SEE ALSO
  946.     MUIA_Window_Screen
  947.